auかんたん決済

auかんたん決済(継続決済) API一覧

※idPass版にのみ対応しています。json版には対応しておりません。

HTTP仕様（.idPass）

Request header
Content-Type: application/x-www-form-urlencoded;charset=windows-31j
Method
POST
Response header
Content-Type: text/plain;charset=windows-31j
Status Code
200：常に200を返却

EntryTranAuContinuance 取引登録

これ以降の決済取引で必要となる取引IDと取引パスワードの発行を行い、取引を開始します。

リクエスト
ShopID shopID 必須 半角英数13桁 固定
ショップID

弊社が発行する値を設定します。

ShopPass shopPass 必須 半角英数64桁
ショップパスワード

弊社が発行する値を設定します。

OrderID orderID 必須 半角英数記号27桁
オーダーID

加盟店様が取引を識別するための値を設定します。

Amount amount 必須 半角数字7桁
課金利用金額

2回目以降の課金利用金額

Tax tax 半角数字7桁
課金税送料

2回目以降の課金税送料
課金税送料を指定した場合は、課金利用金額＋課金税送料が決済金額となります。
課金利用金額＋課金税送料で1円以上9,999,999円以下である必要があります。

FirstAmount firstAmount 必須 半角数字7桁
初回課金利用金額

初回の課金利用金額

FirstTax firstTax 半角数字7桁
初回課金税送料

初回の課金税送料
初回課金税送料を指定した場合は、初回課金利用金額＋初回課金税送料が決済金額となります。
初回課金利用金額＋初回課金税送料で1円以上9,999,999円以下である必要があります。

URL
/payment/EntryTranAuContinuance.json
リクエストパラメータ
{
  "shopID": "tshop11223344",
  "shopPass": "PASSWORD",
  "orderID": "ORDER0000001",
  "amount": "1000",
  "tax": "",
  "firstAmount": "500"
}
URL
/payment/EntryTranAuContinuance.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&OrderID=ORDER0000001&Amount=1000&Tax=&FirstAmount=500
レスポンス
正常
AccessID accessID 半角数字32桁 固定
取引ID

AccessPass accessPass 半角数字32桁 固定
取引パスワード

異常
ErrCode errCode 半角英数3桁 固定
エラーコード
ErrInfo errInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ：正常系
{
  "accessID": "a6a6b0061347e90cdef806b39bd28705",
  "accessPass": "5e0e54b892e14ed03e8cf807a6053813"
}
レスポンスパラメータ：正常系
AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813
レスポンスパラメータ：異常系
{
    "errCode":"E01",
    "errInfo":"E01040001"
}
レスポンスパラメータ：異常系
ErrCode=E01&ErrInfo=E01040001

ExecTranAuContinuance 決済実行

これ以降の決済取引で必要となるトークンを返却します。

リクエスト
ShopID shopID 必須 半角英数13桁 固定
ショップID

ShopPass shopPass 必須 半角英数64桁
ショップパスワード

AccessID accessID 必須 半角英数32桁 固定
取引ID

AccessPass accessPass 必須 半角英数32桁 固定
取引パスワード

OrderID orderID 必須 半角英数記号27桁
オーダーID

SiteID siteID 半角英数13桁 固定
サイトID

弊社が発行する値を設定します。
会員ID指定時は必須です。

SitePass sitePass 半角英数64桁
サイトパスワード

弊社が発行する値を設定します。
会員ID指定時は必須です。

MemberID memberID 半角英数記号60桁
会員ID

決済する対象の会員IDを設定します。
会員IDを指定した場合は2回目以降のauログイン画面をスキップできます。

MemberName memberName 全半角255桁
会員名

登録する名前を設定します。

CreateMember createMember 半角数字1桁 固定
会員作成フラグ

会員が存在しない場合の動作を指定します。

0：登録しない。
会員が存在しない場合、エラーを返す
1：登録する。
会員が存在しない場合、新規登録する

会員ID指定時は必須です。

ClientField1 clientField1 全半角100バイト
加盟店自由項目1

ClientField2 clientField2 全半角100バイト
加盟店自由項目2

ClientField3 clientField3 全半角100バイト
加盟店自由項目3

Commodity commodity 必須 全角48バイト
摘要

エンドユーザが継続課金を認識できる説明、および課金のタイミングを明記します。
※内容が不適切な場合はauかんたん決済サービスが利用停止されることもあります。
記入例
　毎月1日課金
　毎月月末課金
　利用開始されて日付にて毎月課金

AccountTimingKbn accountTimingKbn 必須 半角数字2桁 固定
課金タイミング区分

"01"：課金タイミングで指定
"02"：月末

AccountTiming accountTiming 半角数字2桁
課金タイミング

1~28で設定。（29,30,31は指定不可）

FirstAccountDate firstAccountDate 必須 半角数字8桁 固定
初回課金日

当日から6ヶ月先までの間の日を
yyyyMMddフォーマットで指定。
最大値（6ヶ月先）の例
6/17→12/17、8/31→2/28(29)

RetURL retURL 必須 半角英数記号256桁
決済結果戻しURL

加盟店様が当サービスからの決済結果を受信する為の結果受信URLを設定します。

KDDIセンター上でお客様が認証、支払操作をキャンセルした場合や、当サービスにて決済処理を実行した場合に指定されたURLに結果をリダイレクト経由で送信されます。

PaymentTermSec paymentTermSec 半角数字5桁
支払開始期限秒

お客様が【決済実行】から【支払手続き開始IF】を呼び出すまでの期限です。
最大86,400秒（1日）
呼び出しパラメータが空の場合、120秒で処理されます。

ServiceName serviceName 必須 全角48バイト
表示サービス名

加盟店様のサービス名称です。

ServiceTel serviceTel 必須 半角数字記号15桁
表示電話番号

加盟店様の電話番号です。
設定可能な文字は「半角数字と"-"(ハイフン)」です。

URL
/payment/ExecTranAuContinuance.json
リクエストパラメータ
{
  "shopID": "tshop11223344",
  "shopPass": "PASSWORD",
  "accessID": "a6a6b0061347e90cdef806b39bd28705",
  "accessPass": "5e0e54b892e14ed03e8cf807a6053813",
  "orderID": "ORDER0000001",
  "commodity": "摘要",
  "accountTimingKbn": "01",
  "firstAccountDate": "20220415",
  "retURL": "https://example.com/",
  "serviceName": "サービス名",
  "serviceTel": "0123-456-789"
}
URL
/payment/ExecTranAuContinuance.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&Commodity=摘要&AccountTimingKbn=01&FirstAccountDate=20220415&RetURL=https://example.com/&ServiceName=サービス名&ServiceTel=0123-456-789
レスポンス
正常
AccessID accessID 半角英数32桁 固定
アクセスID

【決済実行】呼び出し時に指定した値を返却します。

Token token 半角数字記号256桁
トークン

アクセスIDのハッシュ値を返却します。

StartURL startURL 256桁
支払手続き開始IFのURL

支払手続き開始IFのURLを返却します。

StartLimitDate startLimitDate 半角数字14桁 固定
支払開始期限日時

支払手続き開始IFの呼び出し期限を返却します。
yyyyMMddHHmmss書式

異常
ErrCode errCode 半角英数3桁 固定
エラーコード
ErrInfo errInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ：正常系
{
  "accessID": "a6a6b0061347e90cdef806b39bd28705",
  "token": "Token=dMb/z8/AQh33zMuhdCDD9DneB+xwFi6MrtvWnmv41lKwBS7yYvxSiC0zeMVH+O4F",
  "startURL": "StartURL=https://pt01.mul-pay.jp/payment/AuContinuanceStart.idPass",
  "startLimitDate": "20221216203940"
}
レスポンスパラメータ：正常系
AccessID=a6a6b0061347e90cdef806b39bd28705&Token=dMb/z8/AQh33zMuhdCDD9DneB+xwFi6MrtvWnmv41lKwBS7yYvxSiC0zeMVH+O4F&StartURL=https://pt01.mul-pay.jp/payment/AuContinuanceStart.idPass&StartLimitDate=20221216203940
レスポンスパラメータ：異常系
{
    "errCode":"E01",
    "errInfo":"E01040001"
}
レスポンスパラメータ：異常系
ErrCode=E01&ErrInfo=E01040001

AuContinuanceStart 登録手続き開始IFの呼び出し

auかんたん決済において、お客様をKDDIセンターのau ID認証画面へと遷移させる必要があります。 ※取引が特定できない場合、すでに登録を済ませている場合等はエラー画面を表示します。

リクエスト
AccessID accessID 必須 32桁 固定
取引ID

Token token 必須 256桁
トークン

URL
/payment/AuContinuanceStart.json
リクエストパラメータ
{
	"accessID": "a6a6b0061347e90cdef806b39bd28705",
	"token": "swVTUaa4Ua11oi3BwzU1UvyTSM4c80Mvs14ucPBthEawBS7yYvxSiC0zeMVH+O4F"
  }
URL
/payment/AuContinuanceStart.idPass
リクエストパラメータ
AccessID=a6a6b0061347e90cdef806b39bd28705&Token=swVTUaa4Ua11oi3BwzU1UvyTSM4c80Mvs14ucPBthEawBS7yYvxSiC0zeMVH+O4F
リダイレクトページサンプル

  <html>
	<head>
	  <meta http-equiv="Content-Type" content="text/html; charset=Windows-31J">
	</head>
	<body OnLoad='OnLoadEvent();'>
	  <form name="AuStartCall" action="{AuStartURL}" method="POST">
	  <noscript>
		<br>
		<br>
		<center>
		  <h2>
		   auかんたん決済画面へ遷移します。
		  </h2>
		  <input type="submit" value="続行">
		</center>
		</noscript>
		<input type="hidden" name="AccessID" value="{AccessID}">
		<input type="hidden" name="Token" value="{Token}">
	  </form>
	  <script>
	  <!--
		function OnLoadEvent() {
		  document.AuStartCall.submit();
		}
	  //-->
	  </script>
	  </body>
  </html>

決済結果受信

KDDIセンターから、当サービスに認証・登録操作結果が通知されます。
認証・登録操作結果は、お客様が登録操作を完了した場合と認証・登録操作をキャンセルした場合に通知されます。
※ブラウザを×ボタンで閉じた場合は、通知されません。
※当サービスが処理中に、お客様の端末がタイムアウトした場合や、同じリクエストを当サービスに対して複数回 行った場合は通知されません。（加盟店様のページを参照するようにメッセージを表示します）
当サービスは、【決済実行】時に指定されたリダイレクトURLに決済結果を通知します。

レスポンス
正常
ShopID shopID 半角英数13桁 固定
ショップID

OrderID orderID 半角英数記号27桁
オーダーID

Status status
現状態

該当取引の取引状態を返却します。
REGISTER：継続課金登録
PAYFAIL：決済失敗

TranDate tranDate 半角数字14桁 固定
処理日時

当サービスで処理を実施した日時を返却します。
yyyyMMddHHmmss書式

AuContinuAccountId auContinuAccountId 半角数字11桁 固定
継続課金ID

継続課金登録処理が正常終了した時に振り出される番号です。
お客様がau ID画面で確認できます。

AuPayMethod auPayMethod 半角数字2桁 固定
支払方法

支払方法です。
01：合算
02：クレジットカード
06：au PAY カード

お客様がau ID画面で確認できます。

異常
ErrCode errCode 半角英数3桁 固定
エラーコード
ErrInfo errInfo 半角英数9桁 固定
エラー詳細コード

AuContinuanceCancel 継続課金解約

継続課金登録した取引に対して解約を行います。

リクエスト
ShopID shopID 必須 半角英数13桁 固定
ショップID

ShopPass shopPass 必須 半角英数64桁
ショップパスワード

AccessID accessID 必須 半角英数32桁 固定
取引ID

AccessPass accessPass 必須 半角英数32桁 固定
取引パスワード

OrderID orderID 必須 半角数字記号27桁
オーダーID

URL
/payment/AuContinuanceCancel.json
リクエストパラメータ
{
  "shopID": "tshop11223344",
  "shopPass": "PASSWORD",
  "accessID": "a6a6b0061347e90cdef806b39bd28705",
  "accessPass": "5e0e54b892e14ed03e8cf807a6053813",
  "orderID": "ORDER0000001"
}
URL
/payment/AuContinuanceCancel.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001
レスポンス
正常
OrderID orderID 半角数字記号27桁
オーダーID

Status status
現状態

解約成功時は以下のステータスが返却されます。
・CANCEL：継続課金解約

異常
ErrCode errCode 半角英数3桁 固定
エラーコード
ErrInfo errInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ：正常系
{
  "orderID": "ORDER0000001",
  "status": "CANCEL"
}
レスポンスパラメータ：正常系
OrderID=ORDER0000001&Status=CANCEL
レスポンスパラメータ：異常系
{
    "errCode":"E01",
    "errInfo":"E01040001"
}
レスポンスパラメータ：異常系
ErrCode=E01&ErrInfo=E01040001

AuContinuanceChargeCancel 課金売上取消・返品

課金日が到来し課金された課金に対して売上取消・返品を行います。

リクエスト
ShopID shopID 必須 半角英数13桁 固定
ショップID

ShopPass shopPass 必須 半角英数64桁
ショップパスワード

AccessID accessID 必須 半角英数32桁 固定
取引ID

AccessPass accessPass 必須 半角英数32桁 固定
取引パスワード

OrderID orderID 必須 半角数字記号27桁
オーダーID

CancelAmount cancelAmount 必須 半角数字7桁
キャンセル金額

0円以上、課金利用金額以内で指定します。

キャンセル金額＋キャンセル税送料で
1円以上で設定する必要があります。

売上取消の場合は課金利用金額全額を指定します。
※返金のみ金額指定可能です。

CancelTax cancelTax 必須 半角数字7桁
キャンセル税送料

0円以上、課金税送料以内で指定します。
キャンセル金額＋キャンセル税送料で1円以上で設定する必要があります。
売上取消の場合は課金利用金額全額を指定します。

※返金のみ金額指定可能です。

例）請求525円より全額キャンセル→
キャンセル金額：525
請求525円より210円分キャンセル→キャンセル金額：210

ContinuanceMonth continuanceMonth 必須 半角数字6桁 固定
課金月

売上取消・返金する課金月を設定します。
yyyyMMフォーマット

URL
/payment/AuContinuanceChargeCancel.json
リクエストパラメータ
{
	"shopID": "tshop11223344",
	"shopPass": "PASSWORD",
	"accessID": "a6a6b0061347e90cdef806b39bd28705",
	"accessPass": "5e0e54b892e14ed03e8cf807a6053813",
	"orderID": "ORDER0000001",
	"cancelAmount": "100",
	"cancelTax": "10",
	"continuanceMonth": "202204"
  }
URL
/payment/AuContinuanceChargeCancel.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&CancelAmount=100&CancelTax=10&ContinuanceMonth=202204
レスポンス
正常
OrderID orderID 半角数字記号27桁
オーダーID

ContinuanceMonth continuanceMonth 半角数字6桁 固定
課金月

売上取消・返品処理を行った課金月を返却します。(yyyyMMフォーマット)

Status status
ステータス

売上取消・返品成功時は以下のステータスが返却されます。
・CANCEL：売上取消
・RETURN：返品

売上取消・返品失敗時は売上取消・返品処理前のステータスが返却されます。

Amount amount 半角数字7桁
利用金額

利用金額からキャンセル金額を減算した結果を返却します。

例）利用金額5000円よりキャンセル金額3000円 => 利用金額2000円

Tax tax 半角数字7桁
税送料

税送料からキャンセル税送料を減算した結果を返却します。

例）税送料250円よりキャンセル税送料150円 => 税送料100円

CancelAmount cancelAmount 半角数字7桁
キャンセル金額

キャンセル金額を返却します。

CancelTax cancelTax 半角数字7桁
キャンセル税送料

キャンセル税送料を返却します。

異常
ErrCode errCode 半角英数3桁 固定
エラーコード
ErrInfo errInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ：正常系
{
	"orderID": "ORDER0000001",
	"continuanceMonth": "202204",
	"status": "CANCEL",
	"amount": "1000",
	"tax": "0",
	"cancelAmount": "100",
	"cancelTax": "10"
  }
レスポンスパラメータ：正常系
OrderID=ORDER0000001&ContinuanceMonth=202204&Status=CANCEL&Amount=1000&Tax=0&CancelAmount=100&CancelTax=10
レスポンスパラメータ：異常系
{
	  "errCode":"E01",
	  "errInfo":"E01040001"
  }
レスポンスパラメータ：異常系
ErrCode=E01&ErrInfo=E01040001

SearchTradeMulti 取引状態参照

指定したオーダーIDの取引情報を取得します。

リクエスト
ShopID shopID 必須 半角英数13桁 固定
ショップID

ShopPass shopPass 必須 半角英数64桁
ショップパスワード

OrderID orderID 必須 半角数字記号27桁
オーダーID

PayType payType 必須 半角数字2桁
決済方法

13：auかんたん継続課金

URL
/payment/SearchTradeMulti.json
リクエストパラメータ
{
  "shopID": "tshop11223344",
  "shopPass": "PASSWORD",
  "orderID": "ORDER0000001",
  "payType": "13"
}
URL
/payment/SearchTradeMulti.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&OrderID=ORDER0000001&PayType=13
レスポンス
正常
Status status
現状態

UNPROCESSED：未決済
REQSUCCESS：要求成功
AUTHPROCESS：認証処理中
CERT_DONE：決済認可完了
REGISTER：継続課金登録
CANCEL：継続課金解約
PAYFAIL：決済失敗

ProcessDate processDate 半角数字14桁
処理日時

処理を実施した日時を返却します。
yyyyMMddHHmmss書式

JobCd jobCd
処理区分

AccessID accessID 半角英数32桁 固定
取引ID

AccessPass accessPass 半角英数32桁 固定
取引パスワード

Amount amount 半角数字7桁
課金利用金額

決済または決済依頼をした継続課金利用金額を返却します。

Tax tax 半角数字7桁
課金税送料

決済または決済依頼をした継続課金税送料を返却します。

SiteID siteID 半角英数13桁
サイトID

MemberID memberID 半角数字記号60桁
会員ID

ClientField1 clientField1 全半角100バイト
加盟店自由項目1

ClientField2 clientField2 全半角100バイト
加盟店自由項目2

ClientField3 clientField3 全半角100バイト
加盟店自由項目3

PayType payType 半角数字2桁
決済方法

13：auかんたん決済継続課金

AuPayMethod auPayMethod 半角数字2桁
au支払方法

購入に使用されたauかんたん決済の支払方法

AccountTimingKbn accountTimingKbn 半角数字2桁
課金タイミング区分

01：日指定
02：月末日

AccountTiming accountTiming 半角数字2桁
課金タイミング

1～28

FirstAccountDate firstAccountDate 半角数字8桁
初回課金日

yyyyMMddフォーマット

FirstAmount firstAmount 半角数字7桁
初回課金利用金額

決済または決済依頼をした初回課金利用金額を返却します。

FirstTax firstTax 半角数字7桁
初回課金税送料

決済または決済依頼をした継続課金税送料を返却します。

AuContinuanceErrCode auContinuanceErrCode 半角英数3桁
au継続課金エラーコード

au継続課金の処理でエラーが発生したときの取引の結果を取得する場合に返却します。

AuContinuanceErrInfo auContinuanceErrInfo 半角英数9桁
au継続課金エラー詳細コード

au継続課金の処理でエラーが発生したときの取引の結果を取得する場合に返却します。

AuContinueAccountId auContinueAccountId 半角数字11桁
au継続課金ID

KDDIにて採番されるID

異常
ErrCode errCode 半角英数3桁 固定
エラーコード
ErrInfo errInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ：正常系
{
  "status": "CANCEL",
  "processDate": "20220824184102",
  "jobCd": "REGISTER",
  "accessID": "a6a6b0061347e90cdef806b39bd28705",
  "accessPass": "5e0e54b892e14ed03e8cf807a6053813",
  "amount": "1000",
  "tax": "0",
  "siteID": "",
  "memberID": "",
  "clientField1": "",
  "clientField2": "",
  "clientField3": "",
  "payType": "13",
  "auPayMethod": "",
  "accountTimingKbn": "01",
  "accountTiming": "1",
  "firstAccountDate": "20220921",
  "firstAmount": "100",
  "firstTax": "0",
  "auContinuanceErrCode": "",
  "auContinuanceErrInfo": "",
  "auContinueAccountId": "46824629440"
}
レスポンスパラメータ：正常系
Status=CANCEL&ProcessDate=20220824184102&JobCd=REGISTER&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&Amount=1000&Tax=0&SiteID=&MemberID=&ClientField1=&ClientField2=&ClientField3=&PayType=13&AuPayMethod=&AccountTimingKbn=01&AccountTiming=1&FirstAccountDate=20220921&FirstAmount=100&FirstTax=0&AuContinuanceErrCode=&AuContinuanceErrInfo=&AuContinueAccountId=46824629440
レスポンスパラメータ：異常系
{
    "errCode":"E01",
    "errInfo":"E01040001"
}
レスポンスパラメータ：異常系
ErrCode=E01&ErrInfo=E01040001